home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / ada / gwuada_9.zip / README < prev    next >
Text File  |  1992-10-05  |  24KB  |  527 lines
  1.  
  2. 1. INTRODUCTION.
  3.  
  4. This file is the README file from the distribution of Ada/Ed version
  5. 1.11.1-PC, an Ada interpreter for 386/486 machines running MS-DOS/PC-DOS.
  6. The distribution consists of a single compressed tar file 
  7. and is available through anonymous ftp on cs.nyu.edu (128.122.140.24)
  8. in the directory pub/adaed.  The distribution contains sources and
  9. executables.  The ftp directory contains another distribution for
  10. Unix-based machines.
  11.  
  12. This program is free software; you can redistribute it and/or modify
  13. it under the terms of the GNU General Purpose License as published by
  14. the Free Software Foundation; either version 2 of the License, or
  15. (at your option) any later version. See relevant excerpts below.
  16.  
  17. Ada/Ed is a translator-interpreter for Ada. It is intended as a teaching
  18. tool, and does not have the capacity, performance,  or robustness of 
  19. commercial Ada compilers. Ada/Ed was developed at New York University, as
  20. part of a long-range project in language definition and software prototyping. 
  21. The project produced the first validated translator for Ada, in the form of
  22. an executable definition of the language written in SETL. The SETL system
  23. served as design document and prototype for the C version being released today.
  24.  
  25. Ada/Ed was last validated under version 1.7 of the ACVC tests. Therefore it is
  26. not currently a validated Ada system, and users can expect to find  small
  27. discrepancies between Ada/Ed and currently validated compilers. 
  28.  
  29. Apart from the 100-odd tests of ACVC 1.11 that Ada/Ed currently fails, the
  30. major deficiency of the system is that, being an interpreter, it does not 
  31. implement most representation clauses, and thus does not support systems 
  32. programming close to the machine level. 
  33.  
  34. We trust that even with these limitations, Ada/Ed will be of use to the
  35. Ada community at large: students, educators, user, and implementors. The 
  36. sources of the system should be of interest to compiler writers, and we hope 
  37. that they will encourage the construction of software tools to make the system
  38. more usable and polished. The NYUADA project does not have the resources to
  39. promise regular new maintenance releases of the software, but will do its
  40. best to keep track of reported errors, workarounds, and fixes. We will also
  41. produce at irregular intervals design notes and additional documentation on
  42. the front-end of the system.  We  urge users to send comments, corrections 
  43. and bug reports (reduced to their simplest form!)  to:   adaed@cs.nyu.edu
  44.  
  45.  
  46. All users of Ada/Ed are urged to register themselves by
  47. sending email to the above address, or to the NYUADA project, New
  48. York University, 251 Mercer Street, New York, NY 10012. This will allow us to
  49. notify users of updates and new releases of the system.
  50.  
  51.  
  52. 2. (UN) WARRANTY
  53.  
  54. This software is release 1.11.1-PC of the Ada/Ed system.
  55. It is distributed absolutely WITHOUT ANY WARRANTY; without even the implied 
  56. warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  57. General Public License for more details.
  58.  
  59. To receive a copy of the GNU General Public License write to the Free
  60. Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139.
  61.  
  62. The following is an excerpt from the GNU General Public License concerning
  63. warranties:
  64.  
  65. Because the program is licensed free of charge, there is no warranty
  66. for the program, to the extent permitted by applicable law.  Except when
  67. otherwise stated in writing the copyright holders and/or other parties
  68. provide the program "as is" without warranty of any kind, either expressed
  69. or implied, including, but not limited to, the implied warranties of
  70. merchantability and fitness for a particular purpose.  The entire risk as
  71. to the quality and performance of the program is with you.  Should the
  72. program prove defective, you assume the cost of all necessary servicing,
  73. repair or correction.
  74.  
  75. In no event unless required by applicable law or agreed to in writing
  76. will any copyright holder, or any other party who may modify and/or
  77. redistribute the program as permitted above, be liable to you for damages,
  78. including any general, special, incidental or consequential damages arising
  79. out of the use or inability to use the program (including but not limited
  80. to loss of data or data being rendered inaccurate or losses sustained by
  81. you or third parties or a failure of the program to operate with any other
  82. programs), even if such holder or other party has been advised of the
  83. possibility of such damages.
  84.  
  85. 3. INSTALLATION
  86.  
  87. To intall Ada/Ed choose a directory to contain the executables and
  88. library files; include this directory on the PATH; set the environment
  89. variable ADAED to the pathname for this directory; and copy the files
  90. *.exe, predef.axq, predef.trc, and predef.lib into the directory.
  91.  
  92. For example, if the directory chosen is C:\ADAED, then the AUTOEXEC.BAT
  93. might contain lines such as:
  94.  
  95. PATH=C:;C:\ADAED
  96. SET ADAED=C:\ADAED
  97.  
  98. Try some of the supplied demo program (see the readme in the demos directory)
  99. Also look at the release.notes for more information about the system and
  100. the changes that have take place.
  101.  
  102. 4. REBUILDING
  103.  
  104. Ada/Ed is written in C, and built using Intel's 386/486 C Code Builder.  
  105. The sources and makefile for doing this are part of the distribution.  To
  106. rebuild, read the makefile and execute "make" and "make predef.lib" or
  107. just "make predef.lib".  In particular, note the comment in the makefile
  108. about the include file makeext.  After rebuilding, follow the installation
  109. instructions above.
  110.  
  111.  
  112. 5. USING Ada/Ed
  113.  
  114. The Ada/Ed system includes the following commands:
  115.  
  116.  adacomp     [ -abgsv ] [ -m  main_unit ] [ -n ] [-l library ]  file
  117.  
  118.  adabind     [ -m  main_unit ]  [-l library]
  119.  
  120.  adaexec     [ -h heap] [ -m   bound_main_unit ] [-p pstack] [-s  tstack]
  121.              [ -r nb_stmts] [ -t [acerst] ]   [-l library]
  122.  
  123.  adalib      [-l library]
  124.  
  125. Description
  126.  
  127. Ada/Ed is a translator/interpreter for the Ada programming language that
  128. is intended primarily for educational use.
  129.  
  130. Adacomp compiles an Ada program; it invokes in succession the two
  131. compilation phases: parsing and semantic analysis (the front end) ,and 
  132. code generation.  The file argument refers to the source file; if no 
  133. extension is given for it, the extension ADA is assumed. The file argument 
  134. may contain drive and directory specifications.  The output of the compiler 
  135. is an instruction stream for an abstract Ada machine, which is then 
  136. interpreted.
  137.  
  138. Adabind binds a given library with the specified main unit to form an
  139. executable program.
  140.  
  141. Adaexec invokes the Ada machine interpreter for the bound program given in 
  142. the specified library. 
  143.  
  144. Adalib displays the contents of the specified library.
  145.  
  146. Note :  All options must precede the file name and may be in either lower or
  147.         upper case.
  148.  
  149. Program Library
  150.  
  151. All compilations require a library. A library is a directory, which is
  152. created or reinitialized when the user invokes a command containing a -n
  153. option such as:
  154.  
  155.     adacomp   -n  -l  libname   adafile
  156.  
  157. Intermediate files appear in directory libname. This directory is created by
  158. the command if it does not already exist. Only the listing files are created
  159. in the directory from which adacomp is invoked. The libname directory should
  160. only be used to hold files created by the adacomp command (i.e. those
  161. produced by the Ada/Ed system); confusion and grief may result if you attempt
  162. to use a library directory to hold other files. The libname argument may
  163. contain drive and path specifications.
  164.  
  165. The libname argument can be omitted if the environment variable ADALIB is
  166. defined. For example, if you are doing several compilations referring to
  167. the same library you can use the command
  168.         SET  ADALIB=C:\MYLIB
  169. to indicate the library to be used. In this way the -l option (including
  170. its library name argument) to adacomp, adabind, adaexec and adalib can be 
  171. omitted.
  172.  
  173. A given utility library UL (e.g. one that contains mathematical functions)
  174. may be used by several unrelated programs. It may then be convenient to
  175. create independent libraries for each program, and i